﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class DeviceFactory
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class DeviceFactory
   ">
    <meta name="generator" content="docfx 2.56.6.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Device.Net.DeviceFactory">
  
  
  <h1 id="Device_Net_DeviceFactory" data-uid="Device.Net.DeviceFactory" class="text-break">Class DeviceFactory
  </h1>
  <div class="markdown level0 summary"></div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">DeviceFactory</span></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="Device.Net.IDeviceFactory.html">IDeviceFactory</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Device.Net.html">Device.Net</a></h6>
  <h6><strong>Assembly</strong>: Device.Net.dll</h6>
  <h5 id="Device_Net_DeviceFactory_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public sealed class DeviceFactory : IDeviceFactory</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/MelbourneDeveloper/Device.Net/new/develop/apiSpec/new?filename=Device_Net_DeviceFactory__ctor_Microsoft_Extensions_Logging_ILoggerFactory_Device_Net_GetConnectedDeviceDefinitionsAsync_Device_Net_GetDeviceAsync_System_Func_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_System_Threading_Tasks_Task_System_Boolean___.md&amp;value=---%0Auid%3A%20Device.Net.DeviceFactory.%23ctor(Microsoft.Extensions.Logging.ILoggerFactory%2CDevice.Net.GetConnectedDeviceDefinitionsAsync%2CDevice.Net.GetDeviceAsync%2CSystem.Func%7BDevice.Net.ConnectedDeviceDefinition%2CSystem.Threading.CancellationToken%2CSystem.Threading.Tasks.Task%7BSystem.Boolean%7D%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/MelbourneDeveloper/Device.Net/blob/develop/src/Device.Net/DeviceFactory.cs/#L30">View Source</a>
  </span>
  <a id="Device_Net_DeviceFactory__ctor_" data-uid="Device.Net.DeviceFactory.#ctor*"></a>
  <h4 id="Device_Net_DeviceFactory__ctor_Microsoft_Extensions_Logging_ILoggerFactory_Device_Net_GetConnectedDeviceDefinitionsAsync_Device_Net_GetDeviceAsync_System_Func_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_System_Threading_Tasks_Task_System_Boolean___" data-uid="Device.Net.DeviceFactory.#ctor(Microsoft.Extensions.Logging.ILoggerFactory,Device.Net.GetConnectedDeviceDefinitionsAsync,Device.Net.GetDeviceAsync,System.Func{Device.Net.ConnectedDeviceDefinition,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})">DeviceFactory(ILoggerFactory, GetConnectedDeviceDefinitionsAsync, GetDeviceAsync, Func&lt;ConnectedDeviceDefinition, CancellationToken, Task&lt;Boolean&gt;&gt;)</h4>
  <div class="markdown level1 summary"><p>Constructs a DeviceFactory</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public DeviceFactory(ILoggerFactory loggerFactory, GetConnectedDeviceDefinitionsAsync getConnectedDevicesAsync, GetDeviceAsync getDevice, Func&lt;ConnectedDeviceDefinition, CancellationToken, Task&lt;bool&gt;&gt; supportsDevice)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">Microsoft.Extensions.Logging.ILoggerFactory</span></td>
        <td><span class="parametername">loggerFactory</span></td>
        <td><p>The factory for creating new loggers for each device</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Device.Net.GetConnectedDeviceDefinitionsAsync.html">GetConnectedDeviceDefinitionsAsync</a></td>
        <td><span class="parametername">getConnectedDevicesAsync</span></td>
        <td><p>A delegate that returns matching connected device definitions</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="Device.Net.GetDeviceAsync.html">GetDeviceAsync</a></td>
        <td><span class="parametername">getDevice</span></td>
        <td><p>A delegate to construct the device based on the specified connected device definition</p>
</td>
      </tr>
      <tr>
        <td><span class="xref">System.Func</span>&lt;<a class="xref" href="Device.Net.ConnectedDeviceDefinition.html">ConnectedDeviceDefinition</a>, <span class="xref">System.Threading.CancellationToken</span>, <span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Boolean</span>&gt;&gt;</td>
        <td><span class="parametername">supportsDevice</span></td>
        <td><p>A delegate that returns whether or not this factory supports the connected device</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/MelbourneDeveloper/Device.Net/new/develop/apiSpec/new?filename=Device_Net_DeviceFactory_GetConnectedDeviceDefinitionsAsync_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Device.Net.DeviceFactory.GetConnectedDeviceDefinitionsAsync(System.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/MelbourneDeveloper/Device.Net/blob/develop/src/Device.Net/DeviceFactory.cs/#L53">View Source</a>
  </span>
  <a id="Device_Net_DeviceFactory_GetConnectedDeviceDefinitionsAsync_" data-uid="Device.Net.DeviceFactory.GetConnectedDeviceDefinitionsAsync*"></a>
  <h4 id="Device_Net_DeviceFactory_GetConnectedDeviceDefinitionsAsync_System_Threading_CancellationToken_" data-uid="Device.Net.DeviceFactory.GetConnectedDeviceDefinitionsAsync(System.Threading.CancellationToken)">GetConnectedDeviceDefinitionsAsync(CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task&lt;IEnumerable&lt;ConnectedDeviceDefinition&gt;&gt; GetConnectedDeviceDefinitionsAsync(CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="Device.Net.ConnectedDeviceDefinition.html">ConnectedDeviceDefinition</a>&gt;&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/MelbourneDeveloper/Device.Net/new/develop/apiSpec/new?filename=Device_Net_DeviceFactory_GetDeviceAsync_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Device.Net.DeviceFactory.GetDeviceAsync(Device.Net.ConnectedDeviceDefinition%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/MelbourneDeveloper/Device.Net/blob/develop/src/Device.Net/DeviceFactory.cs/#L58">View Source</a>
  </span>
  <a id="Device_Net_DeviceFactory_GetDeviceAsync_" data-uid="Device.Net.DeviceFactory.GetDeviceAsync*"></a>
  <h4 id="Device_Net_DeviceFactory_GetDeviceAsync_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_" data-uid="Device.Net.DeviceFactory.GetDeviceAsync(Device.Net.ConnectedDeviceDefinition,System.Threading.CancellationToken)">GetDeviceAsync(ConnectedDeviceDefinition, CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task&lt;IDevice&gt; GetDeviceAsync(ConnectedDeviceDefinition connectedDeviceDefinition, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Device.Net.ConnectedDeviceDefinition.html">ConnectedDeviceDefinition</a></td>
        <td><span class="parametername">connectedDeviceDefinition</span></td>
        <td></td>
      </tr>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="Device.Net.IDevice.html">IDevice</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/MelbourneDeveloper/Device.Net/new/develop/apiSpec/new?filename=Device_Net_DeviceFactory_SupportsDeviceAsync_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20Device.Net.DeviceFactory.SupportsDeviceAsync(Device.Net.ConnectedDeviceDefinition%2CSystem.Threading.CancellationToken)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/MelbourneDeveloper/Device.Net/blob/develop/src/Device.Net/DeviceFactory.cs/#L47">View Source</a>
  </span>
  <a id="Device_Net_DeviceFactory_SupportsDeviceAsync_" data-uid="Device.Net.DeviceFactory.SupportsDeviceAsync*"></a>
  <h4 id="Device_Net_DeviceFactory_SupportsDeviceAsync_Device_Net_ConnectedDeviceDefinition_System_Threading_CancellationToken_" data-uid="Device.Net.DeviceFactory.SupportsDeviceAsync(Device.Net.ConnectedDeviceDefinition,System.Threading.CancellationToken)">SupportsDeviceAsync(ConnectedDeviceDefinition, CancellationToken)</h4>
  <div class="markdown level1 summary"></div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Task&lt;bool&gt; SupportsDeviceAsync(ConnectedDeviceDefinition connectedDeviceDefinition, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Device.Net.ConnectedDeviceDefinition.html">ConnectedDeviceDefinition</a></td>
        <td><span class="parametername">connectedDeviceDefinition</span></td>
        <td></td>
      </tr>
      <tr>
        <td><span class="xref">System.Threading.CancellationToken</span></td>
        <td><span class="parametername">cancellationToken</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">System.Boolean</span>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="Device.Net.IDeviceFactory.html">IDeviceFactory</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="Device.Net.DeviceExtensions.html#Device_Net_DeviceExtensions_Aggregate_Device_Net_IDeviceFactory_Device_Net_IDeviceFactory_Microsoft_Extensions_Logging_ILoggerFactory_">DeviceExtensions.Aggregate(IDeviceFactory, IDeviceFactory, ILoggerFactory)</a>
  </div>
  <div>
      <a class="xref" href="Device.Net.DeviceExtensions.html#Device_Net_DeviceExtensions_GetFirstDeviceAsync_Device_Net_IDeviceFactory_">DeviceExtensions.GetFirstDeviceAsync(IDeviceFactory)</a>
  </div>
  <div>
      <a class="xref" href="Device.Net.DeviceExtensions.html#Device_Net_DeviceExtensions_ConnectFirstAsync_Device_Net_IDeviceFactory_Microsoft_Extensions_Logging_ILogger_">DeviceExtensions.ConnectFirstAsync(IDeviceFactory, ILogger)</a>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/MelbourneDeveloper/Device.Net/new/develop/apiSpec/new?filename=Device_Net_DeviceFactory.md&amp;value=---%0Auid%3A%20Device.Net.DeviceFactory%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                  </li>
                  <li>
                    <a href="https://github.com/MelbourneDeveloper/Device.Net/blob/develop/src/Device.Net/DeviceFactory.cs/#L10" class="contribution-link">View Source</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
